Documentación de Risk Evaluation

NAV Navigation

EvaluationApi v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Email: Iberinform Web: Iberinform

Authentication

  • API Key (ClientSecretHeader)

    • Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
  • API Key (APIKeyHeader)

    • Parameter Name: X-IBM-Client-Id, in: header.

Default

get__evaluation_{organisationID}

Code samples

URL obj = new URL("https://$(catalog.host)/modules/evaluation/{organisationID}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(

 new InputStreamReader(con.getInputStream()));

String inputLine;

StringBuffer response = new StringBuffer();

while ((inputLine = in.readLine()) != null) {

 response.append(inputLine);

}

in.close();

System.out.println(response.toString());




const headers = {

 'Accept':'application/json',

 'X-IBM-Client-Id':'API_KEY',

 'X-IBM-Client-Secret':'API_KEY'

};


fetch('https://$(catalog.host)/modules/evaluation/{organisationID}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});


GET https://$(catalog.host)/modules/evaluation/{organisationID} HTTP/1.1


Accept: application/json


 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY',

);


$client = new \GuzzleHttp\Client();


// Define array of request body.

$request_body = array();


try {

 $response = $client->request('GET','https://$(catalog.host)/modules/evaluation/{organisationID}', array(

 'headers' => $headers,

 'json' => $request_body,

 )

 );

 print_r($response->getBody()->getContents());

 }

 catch (\GuzzleHttp\Exception\BadResponseException $e) {

 // handle exception or api errors.

 print_r($e->getMessage());

 }


 // ...


import requests

headers = {

 'Accept': 'application/json',

 'X-IBM-Client-Id': 'API_KEY',

 'X-IBM-Client-Secret': 'API_KEY'

}


r = requests.get('https://$(catalog.host)/modules/evaluation/{organisationID}', headers = headers)


print(r.json())


require 'rest-client'

require 'json'


headers = {

 'Accept' => 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY'

}


result = RestClient.get 'https://$(catalog.host)/modules/evaluation/{organisationID}',

 params: {

 }, headers: headers


p JSON.parse(result)


# You can also use wget

curl -X GET https://$(catalog.host)/modules/evaluation/{organisationID} \

 -H 'Accept: application/json' \

 -H 'X-IBM-Client-Id: API_KEY' \

 -H 'X-IBM-Client-Secret: API_KEY'



GET /evaluation/{organisationID}

Parameters

Name In Type Required Description
organisationID path string true identificador de la firma
language query string false Idioma generación

Example responses

200 Response

"{"nonPayment":{"definition":{"code":"string","value":"string"},"exclusionaryRule":{"code":"string","value":"string"},"scale":"string"},"nonPaymentRatingComments":{"averageCollectionTime":{"code":"string","value":"string"},"bankDebt":{"code":"string","value":"string"},"businessRule":{"code":"string","value":"string"},"claims":{"code":"string","value":"string"},"financialExpenses":{"code":"string","value":"string"},"group":{"code":"string","value":"string"},"incomeEvolution":{"code":"string","value":"string"},"manualRating":{"code":"string","value":"string"},"nationalClassificationOfEconomicActivities":{"code":"string","value":"string"},"salesEvolution":{"code":"string","value":"string"},"shareholdersEquity":{"code":"string","value":"string"},"treasury":{"code":"string","value":"string"}},"notAvailable":"string","opinionOnCreditworthiness":{"code":"string","value":"string"},"solvency":"string"}"


Responses

Status Meaning Description Schema
200 OK 200 OK EvaluationDetail
401 Unauthorized Unauthorized ErrorDetail
403 Forbidden Forbidden ErrorDetail
404 Not Found Recurso no encontrado ErrorDetail
500 Internal Server Error Internal error ErrorDetail

Schemas

ErrorDetail

"{"code":"string","message":"string","principal":"string","status":0}"



Properties

Name Type Required Restrictions Description
code string false none none
message string false none none
principal string false none none
status number false none none

EvaluationDetail

"{"nonPayment":{"definition":{"code":"string","value":"string"},"exclusionaryRule":{"code":"string","value":"string"},"scale":"string"},"nonPaymentRatingComments":{"averageCollectionTime":{"code":"string","value":"string"},"bankDebt":{"code":"string","value":"string"},"businessRule":{"code":"string","value":"string"},"claims":{"code":"string","value":"string"},"financialExpenses":{"code":"string","value":"string"},"group":{"code":"string","value":"string"},"incomeEvolution":{"code":"string","value":"string"},"manualRating":{"code":"string","value":"string"},"nationalClassificationOfEconomicActivities":{"code":"string","value":"string"},"salesEvolution":{"code":"string","value":"string"},"shareholdersEquity":{"code":"string","value":"string"},"treasury":{"code":"string","value":"string"}},"notAvailable":"string","opinionOnCreditworthiness":{"code":"string","value":"string"},"solvency":"string"}"



Properties

Name Type Required Restrictions Description
nonPayment object false none none
  definition object false none none
   code string false none none
   value string false none none
  exclusionaryRule object false none none
   code string false none none
   value string false none none
  scale string false none none
nonPaymentRatingComments object false none none
  averageCollectionTime object false none none
   code string false none none
   value string false none none
  bankDebt object false none none
   code string false none none
   value string false none none
  businessRule object false none none
   code string false none none
   value string false none none
  claims object false none none
   code string false none none
   value string false none none
  financialExpenses object false none none
   code string false none none
   value string false none none
  group object false none none
   code string false none none
   value string false none none
  incomeEvolution object false none none
   code string false none none
   value string false none none
  manualRating object false none none
   code string false none none
   value string false none none
  nationalClassificationOfEconomicActivities object false none none
   code string false none none
   value string false none none
  salesEvolution object false none none
   code string false none none
   value string false none none
  shareholdersEquity object false none none
   code string false none none
   value string false none none
  treasury object false none none
   code string false none none
   value string false none none
notAvailable string false none none
opinionOnCreditworthiness object false none none
  code string false none none
  value string false none none
solvency string false none none